<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>XSSFWorkbook (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="XSSFWorkbook (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XSSFWorkbook.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFVMLDrawing.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/xssf/usermodel/XSSFWorkbook.html" target="_top">FRAMES</a></li>
<li><a href="XSSFWorkbook.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.xssf.usermodel</p>
<h2 title="Class XSSFWorkbook" class="title">Class XSSFWorkbook</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">org.apache.poi.POIXMLDocumentPart</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">org.apache.poi.POIXMLDocument</a></li>
<li>
<ul class="inheritance">
<li>org.apache.poi.xssf.usermodel.XSSFWorkbook</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.Iterable&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&gt;, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></dd>
</dl>
<hr>
<br>
<pre>public class <strong>XSSFWorkbook</strong>
extends <a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a>
implements <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>, java.lang.Iterable&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&gt;</pre>
<div class="block">High level representation of a SpreadsheetML workbook.  This is the first object most users
 will construct whether they are reading or writing a workbook.  It is also the
 top level object for creating new sheets/etc.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#DEFAULT_CHARACTER_WIDTH">DEFAULT_CHARACTER_WIDTH</a></strong></code>
<div class="block">Width of one character of the default font in pixels.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#PICTURE_TYPE_BMP">PICTURE_TYPE_BMP</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#PICTURE_TYPE_EPS">PICTURE_TYPE_EPS</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#PICTURE_TYPE_GIF">PICTURE_TYPE_GIF</a></strong></code>
<div class="block">Images formats supported by XSSF but not by HSSF</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#PICTURE_TYPE_TIFF">PICTURE_TYPE_TIFF</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#PICTURE_TYPE_WPG">PICTURE_TYPE_WPG</a></strong></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.POIXMLDocument">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></h3>
<code><a href="../../../../../org/apache/poi/POIXMLDocument.html#DOCUMENT_CREATOR">DOCUMENT_CREATOR</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#OLE_OBJECT_REL_TYPE">OLE_OBJECT_REL_TYPE</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#PACK_OBJECT_REL_TYPE">PACK_OBJECT_REL_TYPE</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.POIXMLDocumentPart">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></h3>
<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#DEFAULT_XML_OPTIONS">DEFAULT_XML_OPTIONS</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.ss.usermodel.Workbook">
<!--   -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></h3>
<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_DIB">PICTURE_TYPE_DIB</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_EMF">PICTURE_TYPE_EMF</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_JPEG">PICTURE_TYPE_JPEG</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PICT">PICTURE_TYPE_PICT</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PNG">PICTURE_TYPE_PNG</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_WMF">PICTURE_TYPE_WMF</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#SHEET_STATE_HIDDEN">SHEET_STATE_HIDDEN</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#SHEET_STATE_VERY_HIDDEN">SHEET_STATE_VERY_HIDDEN</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#SHEET_STATE_VISIBLE">SHEET_STATE_VISIBLE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#XSSFWorkbook()">XSSFWorkbook</a></strong>()</code>
<div class="block">Create a new SpreadsheetML workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#XSSFWorkbook(java.io.File)">XSSFWorkbook</a></strong>(java.io.File&nbsp;file)</code>
<div class="block">Constructs a XSSFWorkbook object from a given file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#XSSFWorkbook(java.io.InputStream)">XSSFWorkbook</a></strong>(java.io.InputStream&nbsp;is)</code>
<div class="block">Constructs a XSSFWorkbook object, by buffering the whole stream into memory
  and then opening an <a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc"><code>OPCPackage</code></a> object for it.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#XSSFWorkbook(org.apache.poi.openxml4j.opc.OPCPackage)">XSSFWorkbook</a></strong>(<a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a>&nbsp;pkg)</code>
<div class="block">Constructs a XSSFWorkbook object given a OpenXML4J <code>Package</code> object,
  see <a href="http://poi.apache.org/oxml4j/">http://poi.apache.org/oxml4j/</a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#XSSFWorkbook(java.lang.String)">XSSFWorkbook</a></strong>(java.lang.String&nbsp;path)</code>
<div class="block">Constructs a XSSFWorkbook object given a file name.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#addPicture(byte[], int)">addPicture</a></strong>(byte[]&nbsp;pictureData,
          int&nbsp;format)</code>
<div class="block">Adds a picture to the workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#addPicture(java.io.InputStream, int)">addPicture</a></strong>(java.io.InputStream&nbsp;is,
          int&nbsp;format)</code>
<div class="block">Adds a picture to the workbook.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotCache</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#addPivotCache(java.lang.String)">addPivotCache</a></strong>(java.lang.String&nbsp;rId)</code>
<div class="block">Add pivotCache to the workbook</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#addToolPack(org.apache.poi.ss.formula.udf.UDFFinder)">addToolPack</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a>&nbsp;toopack)</code>
<div class="block">Register a new toolpack in this workbook.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#beforeDocumentRead()">beforeDocumentRead</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#cloneSheet(int)">cloneSheet</a></strong>(int&nbsp;sheetNum)</code>
<div class="block">Create an XSSFSheet from an existing sheet in the XSSFWorkbook.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#close()">close</a></strong>()</code>
<div class="block">Closes the underlying <a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc"><code>OPCPackage</code></a> from which
  the Workbook was read, if any.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#commit()">commit</a></strong>()</code>
<div class="block">Save the content in the underlying package part.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCellStyle.html" title="class in org.apache.poi.xssf.usermodel">XSSFCellStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#createCellStyle()">createCellStyle</a></strong>()</code>
<div class="block">Create a new XSSFCellStyle and add it to the workbook's style table</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFDataFormat.html" title="class in org.apache.poi.xssf.usermodel">XSSFDataFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#createDataFormat()">createDataFormat</a></strong>()</code>
<div class="block">Returns the instance of XSSFDataFormat for this workbook.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFDialogsheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFDialogsheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#createDialogsheet(java.lang.String, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDialogsheet)">createDialogsheet</a></strong>(java.lang.String&nbsp;sheetname,
                 org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDialogsheet&nbsp;dialogsheet)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html" title="class in org.apache.poi.xssf.usermodel">XSSFFont</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#createFont()">createFont</a></strong>()</code>
<div class="block">Create a new Font and add it to the workbook's font table</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#createName()">createName</a></strong>()</code>
<div class="block">Creates a new (uninitialised) defined name in this workbook</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#createSheet()">createSheet</a></strong>()</code>
<div class="block">Create an XSSFSheet for this workbook, adds it to the sheets and returns
 the high level representation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#createSheet(java.lang.String)">createSheet</a></strong>(java.lang.String&nbsp;sheetname)</code>
<div class="block">Create a new sheet for this Workbook and return the high level representation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html" title="class in org.apache.poi.xssf.usermodel">XSSFFont</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#findFont(short, short, short, java.lang.String, boolean, boolean, short, byte)">findFont</a></strong>(short&nbsp;boldWeight,
        short&nbsp;color,
        short&nbsp;fontHeight,
        java.lang.String&nbsp;name,
        boolean&nbsp;italic,
        boolean&nbsp;strikeout,
        short&nbsp;typeOffset,
        byte&nbsp;underline)</code>
<div class="block">Finds a font that matches the one with the supplied attributes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getActiveSheetIndex()">getActiveSheetIndex</a></strong>()</code>
<div class="block">Convenience method to get the active sheet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getAllEmbedds()">getAllEmbedds</a></strong>()</code>
<div class="block">Get the document's embedded files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPictureData.html" title="class in org.apache.poi.xssf.usermodel">XSSFPictureData</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getAllPictures()">getAllPictures</a></strong>()</code>
<div class="block">Gets all pictures from the Workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/CalculationChain.html" title="class in org.apache.poi.xssf.model">CalculationChain</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCalculationChain()">getCalculationChain</a></strong>()</code>
<div class="block">Return the <a href="../../../../../org/apache/poi/xssf/model/CalculationChain.html" title="class in org.apache.poi.xssf.model"><code>CalculationChain</code></a> object for this workbook</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCellStyle.html" title="class in org.apache.poi.xssf.usermodel">XSSFCellStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCellStyleAt(short)">getCellStyleAt</a></strong>(short&nbsp;idx)</code>
<div class="block">Get the cell style object at the given index</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCreationHelper.html" title="class in org.apache.poi.xssf.usermodel">XSSFCreationHelper</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCreationHelper()">getCreationHelper</a></strong>()</code>
<div class="block">Returns an object that handles instantiating concrete
  classes of the various instances for XSSF.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorkbook</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCTWorkbook()">getCTWorkbook</a></strong>()</code>
<div class="block">Return the underlying XML bean</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFMap.html" title="class in org.apache.poi.xssf.usermodel">XSSFMap</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getCustomXMLMappings()">getCustomXMLMappings</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xssf/model/ExternalLinksTable.html" title="class in org.apache.poi.xssf.model">ExternalLinksTable</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getExternalLinksTable()">getExternalLinksTable</a></strong>()</code>
<div class="block">Returns the list of <a href="../../../../../org/apache/poi/xssf/model/ExternalLinksTable.html" title="class in org.apache.poi.xssf.model"><code>ExternalLinksTable</code></a> object for this workbook</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getFirstVisibleTab()">getFirstVisibleTab</a></strong>()</code>
<div class="block">Gets the first tab that is displayed in the list of tabs in excel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html" title="class in org.apache.poi.xssf.usermodel">XSSFFont</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getFontAt(short)">getFontAt</a></strong>(short&nbsp;idx)</code>
<div class="block">Get the font at the given index number</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getForceFormulaRecalculation()">getForceFormulaRecalculation</a></strong>()</code>
<div class="block">Whether Excel will be asked to recalculate all formulas when the  workbook is opened.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/MapInfo.html" title="class in org.apache.poi.xssf.model">MapInfo</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getMapInfo()">getMapInfo</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getMissingCellPolicy()">getMissingCellPolicy</a></strong>()</code>
<div class="block">Retrieves the current policy on what to do when
  getting missing or blank cells from a row.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getName(java.lang.String)">getName</a></strong>(java.lang.String&nbsp;name)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNameAt(int)">getNameAt</a></strong>(int&nbsp;nameIndex)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNameIndex(java.lang.String)">getNameIndex</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Gets the named range index by his name
 <i>Note:</i>Excel named ranges are case-insensitive and
 this method performs a case-insensitive search.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNumberOfFonts()">getNumberOfFonts</a></strong>()</code>
<div class="block">Get the number of fonts in the this workbook</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNumberOfNames()">getNumberOfNames</a></strong>()</code>
<div class="block">Get the number of named ranges in the this workbook</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNumberOfSheets()">getNumberOfSheets</a></strong>()</code>
<div class="block">Get the number of worksheets in the this workbook</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getNumCellStyles()">getNumCellStyles</a></strong>()</code>
<div class="block">Get the number of styles the workbook contains</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPivotTable.html" title="class in org.apache.poi.xssf.usermodel">XSSFPivotTable</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getPivotTables()">getPivotTables</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getPrintArea(int)">getPrintArea</a></strong>(int&nbsp;sheetIndex)</code>
<div class="block">Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/SharedStringsTable.html" title="class in org.apache.poi.xssf.model">SharedStringsTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSharedStringSource()">getSharedStringSource</a></strong>()</code>
<div class="block">Returns SharedStringsTable - tha cache of string for this workbook</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheet(java.lang.String)">getSheet</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Get sheet with the given name (case insensitive match)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheetAt(int)">getSheetAt</a></strong>(int&nbsp;index)</code>
<div class="block">Get the XSSFSheet object at the given index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheetIndex(org.apache.poi.ss.usermodel.Sheet)">getSheetIndex</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a>&nbsp;sheet)</code>
<div class="block">Returns the index of the given sheet</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheetIndex(java.lang.String)">getSheetIndex</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Returns the index of the sheet by his name (case insensitive match)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getSheetName(int)">getSheetName</a></strong>(int&nbsp;sheetIx)</code>
<div class="block">Get the sheet name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/StylesTable.html" title="class in org.apache.poi.xssf.model">StylesTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getStylesSource()">getStylesSource</a></strong>()</code>
<div class="block">Return a object representing a collection of shared objects used for styling content,
 e.g.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/xssf/model/ThemesTable.html" title="class in org.apache.poi.xssf.model">ThemesTable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getTheme()">getTheme</a></strong>()</code>
<div class="block">Returns the Theme of current workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isDate1904()">isDate1904</a></strong>()</code>
<div class="block">Gets a boolean value that indicates whether the date systems used in the workbook starts in 1904.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isHidden()">isHidden</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isMacroEnabled()">isMacroEnabled</a></strong>()</code>
<div class="block">Are we a normal workbook (.xlsx), or a
  macro enabled workbook (.xlsm)?</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isRevisionLocked()">isRevisionLocked</a></strong>()</code>
<div class="block">Specifies a boolean value that indicates whether the workbook is locked for revisions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isSheetHidden(int)">isSheetHidden</a></strong>(int&nbsp;sheetIx)</code>
<div class="block">Check whether a sheet is hidden.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isSheetVeryHidden(int)">isSheetVeryHidden</a></strong>(int&nbsp;sheetIx)</code>
<div class="block">Check whether a sheet is very hidden.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isStructureLocked()">isStructureLocked</a></strong>()</code>
<div class="block">Specifies a boolean value that indicates whether structure of workbook is locked.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isWindowsLocked()">isWindowsLocked</a></strong>()</code>
<div class="block">Specifies a boolean value that indicates whether the windows that comprise the workbook are locked.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Iterator&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#iterator()">iterator</a></strong>()</code>
<div class="block">Allows foreach loops:</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#linkExternalWorkbook(java.lang.String, org.apache.poi.ss.usermodel.Workbook)">linkExternalWorkbook</a></strong>(java.lang.String&nbsp;name,
                    <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>&nbsp;workbook)</code>
<div class="block">Adds the External Link Table part and relations required to allow formulas 
  referencing the specified external workbook to be added to this one.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#lockRevision()">lockRevision</a></strong>()</code>
<div class="block">Locks the workbook for revisions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#lockStructure()">lockStructure</a></strong>()</code>
<div class="block">Locks the structure of workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#lockWindows()">lockWindows</a></strong>()</code>
<div class="block">Locks the windows that comprise the workbook.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#newPackage()">newPackage</a></strong>()</code>
<div class="block">Create a new SpreadsheetML package and setup the default minimal content</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#onDeleteFormula(org.apache.poi.xssf.usermodel.XSSFCell)">onDeleteFormula</a></strong>(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCell.html" title="class in org.apache.poi.xssf.usermodel">XSSFCell</a>&nbsp;cell)</code>
<div class="block">Fired when a formula is deleted from this workbook,
 for example when calling cell.setCellFormula(null)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#onDocumentRead()">onDocumentRead</a></strong>()</code>
<div class="block">Fired when a package part is read</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(int)">removeName</a></strong>(int&nbsp;nameIndex)</code>
<div class="block">Remove the defined name at the specified index</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeName(java.lang.String)">removeName</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Remove a defined name by name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removePrintArea(int)">removePrintArea</a></strong>(int&nbsp;sheetIndex)</code>
<div class="block">Delete the printarea for the sheet specified</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#removeSheetAt(int)">removeSheetAt</a></strong>(int&nbsp;index)</code>
<div class="block">Removes sheet at the given index.<p/>

 Care must be taken if the removed sheet is the currently active or only selected sheet in
 the workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setActiveSheet(int)">setActiveSheet</a></strong>(int&nbsp;index)</code>
<div class="block">Convenience method to set the active sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setFirstVisibleTab(int)">setFirstVisibleTab</a></strong>(int&nbsp;index)</code>
<div class="block">Sets the first tab that is displayed in the list of tabs in excel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setForceFormulaRecalculation(boolean)">setForceFormulaRecalculation</a></strong>(boolean&nbsp;value)</code>
<div class="block">Whether the application shall perform a full recalculation when the workbook is opened.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setHidden(boolean)">setHidden</a></strong>(boolean&nbsp;hiddenFlag)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy)">setMissingCellPolicy</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a>&nbsp;missingCellPolicy)</code>
<div class="block">Sets the policy on what to do when
  getting missing or blank cells from a row.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setPivotTables(java.util.List)">setPivotTables</a></strong>(java.util.List&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPivotTable.html" title="class in org.apache.poi.xssf.usermodel">XSSFPivotTable</a>&gt;&nbsp;pivotTables)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setPrintArea(int, int, int, int, int)">setPrintArea</a></strong>(int&nbsp;sheetIndex,
            int&nbsp;startColumn,
            int&nbsp;endColumn,
            int&nbsp;startRow,
            int&nbsp;endRow)</code>
<div class="block">For the Convenience of Java Programmers maintaining pointers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setPrintArea(int, java.lang.String)">setPrintArea</a></strong>(int&nbsp;sheetIndex,
            java.lang.String&nbsp;reference)</code>
<div class="block">Sets the printarea for the sheet provided</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setRepeatingRowsAndColumns(int, int, int, int, int)">setRepeatingRowsAndColumns</a></strong>(int&nbsp;sheetIndex,
                          int&nbsp;startColumn,
                          int&nbsp;endColumn,
                          int&nbsp;startRow,
                          int&nbsp;endRow)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#setRepeatingRows(org.apache.poi.ss.util.CellRangeAddress)"><code>XSSFSheet.setRepeatingRows(CellRangeAddress)</code></a>
        or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#setRepeatingColumns(org.apache.poi.ss.util.CellRangeAddress)"><code>XSSFSheet.setRepeatingColumns(CellRangeAddress)</code></a></i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setRevisionsPassword(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">setRevisionsPassword</a></strong>(java.lang.String&nbsp;password,
                    <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</code>
<div class="block">Sets the revisions password.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSelectedTab(int)">setSelectedTab</a></strong>(int&nbsp;index)</code>
<div class="block">We only set one sheet as selected for compatibility with HSSF.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetHidden(int, boolean)">setSheetHidden</a></strong>(int&nbsp;sheetIx,
              boolean&nbsp;hidden)</code>
<div class="block">Sets the visible state of this sheet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetHidden(int, int)">setSheetHidden</a></strong>(int&nbsp;sheetIx,
              int&nbsp;state)</code>
<div class="block">Hide or unhide a sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetName(int, java.lang.String)">setSheetName</a></strong>(int&nbsp;sheetIndex,
            java.lang.String&nbsp;sheetname)</code>
<div class="block">Set the sheet name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetOrder(java.lang.String, int)">setSheetOrder</a></strong>(java.lang.String&nbsp;sheetname,
             int&nbsp;pos)</code>
<div class="block">sets the order of appearance for a given sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setWorkbookPassword(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">setWorkbookPassword</a></strong>(java.lang.String&nbsp;password,
                   <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</code>
<div class="block">Sets the workbook password.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#unLock()">unLock</a></strong>()</code>
<div class="block">Removes the workbook protection settings</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#unLockRevision()">unLockRevision</a></strong>()</code>
<div class="block">Unlocks the workbook for revisions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#unLockStructure()">unLockStructure</a></strong>()</code>
<div class="block">Unlocks the structure of workbook.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#unLockWindows()">unLockWindows</a></strong>()</code>
<div class="block">Unlocks the windows that comprise the workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#validateRevisionsPassword(java.lang.String)">validateRevisionsPassword</a></strong>(java.lang.String&nbsp;password)</code>
<div class="block">Validate the password against the stored hash, the hashing method will be determined
  by the existing password attributes</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#validateWorkbookPassword(java.lang.String)">validateWorkbookPassword</a></strong>(java.lang.String&nbsp;password)</code>
<div class="block">Validate the password against the stored hash, the hashing method will be determined
  by the existing password attributes</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIXMLDocument">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></h3>
<code><a href="../../../../../org/apache/poi/POIXMLDocument.html#getCorePart()">getCorePart</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#getPackage()">getPackage</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#getProperties()">getProperties</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#getRelatedByType(java.lang.String)">getRelatedByType</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#hasOOXMLHeader(java.io.InputStream)">hasOOXMLHeader</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#load(org.apache.poi.POIXMLFactory)">load</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#openPackage(java.lang.String)">openPackage</a>, <a href="../../../../../org/apache/poi/POIXMLDocument.html#write(java.io.OutputStream)">write</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIXMLDocumentPart">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></h3>
<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#addRelation(java.lang.String, org.apache.poi.POIXMLDocumentPart)">addRelation</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#createRelationship(org.apache.poi.POIXMLRelation, org.apache.poi.POIXMLFactory)">createRelationship</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#createRelationship(org.apache.poi.POIXMLRelation, org.apache.poi.POIXMLFactory, int)">createRelationship</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#createRelationship(org.apache.poi.POIXMLRelation, org.apache.poi.POIXMLFactory, int, boolean)">createRelationship</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getPackagePart()">getPackagePart</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getPackageRelationship()">getPackageRelationship</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getParent()">getParent</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getRelationById(java.lang.String)">getRelationById</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getRelationId(org.apache.poi.POIXMLDocumentPart)">getRelationId</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getRelations()">getRelations</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#getTargetPart(org.apache.poi.openxml4j.opc.PackageRelationship)">getTargetPart</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onDocumentCreate()">onDocumentCreate</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onDocumentRemove()">onDocumentRemove</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onSave(java.util.Set)">onSave</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#prepareForCommit()">prepareForCommit</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#read(org.apache.poi.POIXMLFactory, java.util.Map)">read</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#rebase(org.apache.poi.openxml4j.opc.OPCPackage)">rebase</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#removeRelation(org.apache.poi.POIXMLDocumentPart)">removeRelation</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#removeRelation(org.apache.poi.POIXMLDocumentPart, boolean)">removeRelation</a>, <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ss.usermodel.Workbook">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></h3>
<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#write(java.io.OutputStream)">write</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_CHARACTER_WIDTH">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CHARACTER_WIDTH</h4>
<pre>public static final&nbsp;float DEFAULT_CHARACTER_WIDTH</pre>
<div class="block">Width of one character of the default font in pixels. Same for Calibry and Arial.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.xssf.usermodel.XSSFWorkbook.DEFAULT_CHARACTER_WIDTH">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PICTURE_TYPE_GIF">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PICTURE_TYPE_GIF</h4>
<pre>public static final&nbsp;int PICTURE_TYPE_GIF</pre>
<div class="block">Images formats supported by XSSF but not by HSSF</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.xssf.usermodel.XSSFWorkbook.PICTURE_TYPE_GIF">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PICTURE_TYPE_TIFF">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PICTURE_TYPE_TIFF</h4>
<pre>public static final&nbsp;int PICTURE_TYPE_TIFF</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.xssf.usermodel.XSSFWorkbook.PICTURE_TYPE_TIFF">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PICTURE_TYPE_EPS">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PICTURE_TYPE_EPS</h4>
<pre>public static final&nbsp;int PICTURE_TYPE_EPS</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.xssf.usermodel.XSSFWorkbook.PICTURE_TYPE_EPS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PICTURE_TYPE_BMP">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PICTURE_TYPE_BMP</h4>
<pre>public static final&nbsp;int PICTURE_TYPE_BMP</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.xssf.usermodel.XSSFWorkbook.PICTURE_TYPE_BMP">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="PICTURE_TYPE_WPG">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PICTURE_TYPE_WPG</h4>
<pre>public static final&nbsp;int PICTURE_TYPE_WPG</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.xssf.usermodel.XSSFWorkbook.PICTURE_TYPE_WPG">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="XSSFWorkbook()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XSSFWorkbook</h4>
<pre>public&nbsp;XSSFWorkbook()</pre>
<div class="block">Create a new SpreadsheetML workbook.</div>
</li>
</ul>
<a name="XSSFWorkbook(org.apache.poi.openxml4j.opc.OPCPackage)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XSSFWorkbook</h4>
<pre>public&nbsp;XSSFWorkbook(<a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a>&nbsp;pkg)
             throws java.io.IOException</pre>
<div class="block">Constructs a XSSFWorkbook object given a OpenXML4J <code>Package</code> object,
  see <a href="http://poi.apache.org/oxml4j/">http://poi.apache.org/oxml4j/</a>.
 
 <p>Once you have finished working with the Workbook, you should close the package
 by calling either <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#close()"><code>close()</code></a> or <a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html#close()"><code>OPCPackage.close()</code></a>, to avoid 
 leaving file handles open.
 
 <p>Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory
  footprint than an InputStream backed one.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pkg</code> - the OpenXML4J <code>OPC Package</code> object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="XSSFWorkbook(java.io.InputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XSSFWorkbook</h4>
<pre>public&nbsp;XSSFWorkbook(java.io.InputStream&nbsp;is)
             throws java.io.IOException</pre>
<div class="block">Constructs a XSSFWorkbook object, by buffering the whole stream into memory
  and then opening an <a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc"><code>OPCPackage</code></a> object for it.
 
 <p>Using an <code>InputStream</code> requires more memory than using a File, so
  if a <code>File</code> is available then you should instead do something like
   <pre><code>
       OPCPackage pkg = OPCPackage.open(path);
       XSSFWorkbook wb = new XSSFWorkbook(pkg);
       // work with the wb object
       ......
       pkg.close(); // gracefully closes the underlying zip file
   </code></pre></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="XSSFWorkbook(java.io.File)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XSSFWorkbook</h4>
<pre>public&nbsp;XSSFWorkbook(java.io.File&nbsp;file)
             throws java.io.IOException,
                    <a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a></pre>
<div class="block">Constructs a XSSFWorkbook object from a given file.
 
 <p>Once you have finished working with the Workbook, you should close 
 the package by calling  <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#close()"><code>close()</code></a>, to avoid leaving file 
 handles open.
 
 <p>Opening a XSSFWorkbook from a file has a lower memory footprint 
  than opening from an InputStream</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the file to open</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code><a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a></code></dd></dl>
</li>
</ul>
<a name="XSSFWorkbook(java.lang.String)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XSSFWorkbook</h4>
<pre>public&nbsp;XSSFWorkbook(java.lang.String&nbsp;path)
             throws java.io.IOException</pre>
<div class="block">Constructs a XSSFWorkbook object given a file name.

 
 <p>Once you have finished working with the Workbook, you should close 
 the package by calling  <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#close()"><code>close()</code></a>, to avoid leaving file 
 handles open.
 
 <p>Opening a XSSFWorkbook from a file has a lower memory footprint 
  than opening from an InputStream</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the file name.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="beforeDocumentRead()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beforeDocumentRead</h4>
<pre>protected&nbsp;void&nbsp;beforeDocumentRead()</pre>
</li>
</ul>
<a name="onDocumentRead()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDocumentRead</h4>
<pre>protected&nbsp;void&nbsp;onDocumentRead()
                       throws java.io.IOException</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onDocumentRead()">POIXMLDocumentPart</a></code></strong></div>
<div class="block">Fired when a package part is read</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#onDocumentRead()">onDocumentRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="newPackage()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newPackage</h4>
<pre>protected static&nbsp;<a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a>&nbsp;newPackage()</pre>
<div class="block">Create a new SpreadsheetML package and setup the default minimal content</div>
</li>
</ul>
<a name="getCTWorkbook()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCTWorkbook</h4>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public&nbsp;org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorkbook&nbsp;getCTWorkbook()</pre>
<div class="block">Return the underlying XML bean</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the underlying CTWorkbook bean</dd></dl>
</li>
</ul>
<a name="addPicture(byte[], int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPicture</h4>
<pre>public&nbsp;int&nbsp;addPicture(byte[]&nbsp;pictureData,
             int&nbsp;format)</pre>
<div class="block">Adds a picture to the workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#addPicture(byte[], int)">addPicture</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pictureData</code> - The bytes of the picture</dd><dd><code>format</code> - The format of the picture.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index to this picture (0 based), the added picture can be obtained from <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getAllPictures()"><code>getAllPictures()</code></a> .</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_EMF"><code>Workbook.PICTURE_TYPE_EMF</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_WMF"><code>Workbook.PICTURE_TYPE_WMF</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PICT"><code>Workbook.PICTURE_TYPE_PICT</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_JPEG"><code>Workbook.PICTURE_TYPE_JPEG</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PNG"><code>Workbook.PICTURE_TYPE_PNG</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_DIB"><code>Workbook.PICTURE_TYPE_DIB</code></a>, 
<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getAllPictures()"><code>getAllPictures()</code></a></dd></dl>
</li>
</ul>
<a name="addPicture(java.io.InputStream, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPicture</h4>
<pre>public&nbsp;int&nbsp;addPicture(java.io.InputStream&nbsp;is,
             int&nbsp;format)
               throws java.io.IOException</pre>
<div class="block">Adds a picture to the workbook.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - The sream to read image from</dd><dd><code>format</code> - The format of the picture.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the index to this picture (0 based), the added picture can be obtained from <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getAllPictures()"><code>getAllPictures()</code></a> .</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_EMF"><code>Workbook.PICTURE_TYPE_EMF</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_WMF"><code>Workbook.PICTURE_TYPE_WMF</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PICT"><code>Workbook.PICTURE_TYPE_PICT</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_JPEG"><code>Workbook.PICTURE_TYPE_JPEG</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PNG"><code>Workbook.PICTURE_TYPE_PNG</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_DIB"><code>Workbook.PICTURE_TYPE_DIB</code></a>, 
<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#getAllPictures()"><code>getAllPictures()</code></a></dd></dl>
</li>
</ul>
<a name="cloneSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneSheet</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&nbsp;cloneSheet(int&nbsp;sheetNum)</pre>
<div class="block">Create an XSSFSheet from an existing sheet in the XSSFWorkbook.
  The cloned sheet is a deep copy of the original.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#cloneSheet(int)">cloneSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>XSSFSheet representing the cloned sheet.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the sheet index in invalid</dd>
<dd><code><a href="../../../../../org/apache/poi/POIXMLException.html" title="class in org.apache.poi">POIXMLException</a></code> - if there were errors when cloning</dd></dl>
</li>
</ul>
<a name="createCellStyle()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCellStyle</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCellStyle.html" title="class in org.apache.poi.xssf.usermodel">XSSFCellStyle</a>&nbsp;createCellStyle()</pre>
<div class="block">Create a new XSSFCellStyle and add it to the workbook's style table</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createCellStyle()">createCellStyle</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the new XSSFCellStyle object</dd></dl>
</li>
</ul>
<a name="createDataFormat()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDataFormat</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFDataFormat.html" title="class in org.apache.poi.xssf.usermodel">XSSFDataFormat</a>&nbsp;createDataFormat()</pre>
<div class="block">Returns the instance of XSSFDataFormat for this workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createDataFormat()">createDataFormat</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the XSSFDataFormat object</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/DataFormat.html" title="interface in org.apache.poi.ss.usermodel"><code>DataFormat</code></a></dd></dl>
</li>
</ul>
<a name="createFont()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFont</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html" title="class in org.apache.poi.xssf.usermodel">XSSFFont</a>&nbsp;createFont()</pre>
<div class="block">Create a new Font and add it to the workbook's font table</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createFont()">createFont</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>new font object</dd></dl>
</li>
</ul>
<a name="createName()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a>&nbsp;createName()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createName()">Workbook</a></code></strong></div>
<div class="block">Creates a new (uninitialised) defined name in this workbook</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createName()">createName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>new defined name object</dd></dl>
</li>
</ul>
<a name="createSheet()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSheet</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&nbsp;createSheet()</pre>
<div class="block">Create an XSSFSheet for this workbook, adds it to the sheets and returns
 the high level representation.  Use this to create new sheets.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createSheet()">createSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>XSSFSheet representing the new sheet.</dd></dl>
</li>
</ul>
<a name="createSheet(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSheet</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&nbsp;createSheet(java.lang.String&nbsp;sheetname)</pre>
<div class="block">Create a new sheet for this Workbook and return the high level representation.
 Use this to create new sheets.

 <p>
     Note that Excel allows sheet names up to 31 chars in length but other applications
     (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars,
     others - truncate such names to 31 character.
 </p>
 <p>
     POI's SpreadsheetAPI silently truncates the input argument to 31 characters.
     Example:

     <pre><code>
     Sheet sheet = workbook.createSheet("My very long sheet name which is longer than 31 chars"); // will be truncated
     assert 31 == sheet.getSheetName().length();
     assert "My very long sheet name which i" == sheet.getSheetName();
     </code></pre>
 </p>

 Except the 31-character constraint, Excel applies some other rules:
 <p>
 Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
 <ul>
 <li> 0x0000 </li>
 <li> 0x0003 </li>
 <li> colon (:) </li>
 <li> backslash (\) </li>
 <li> asterisk (*) </li>
 <li> question mark (?) </li>
 <li> forward slash (/) </li>
 <li> opening square bracket ([) </li>
 <li> closing square bracket (]) </li>
 </ul>
 The string MUST NOT begin or end with the single quote (') character.
 </p>

 <p>
 See <a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#createSafeSheetName(java.lang.String)"><code>WorkbookUtil.createSafeSheetName(String nameProposal)</code></a>
      for a safe way to create valid names
 </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createSheet(java.lang.String)">createSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetname</code> - sheetname to set for the sheet.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Sheet representing the new sheet.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the name is null or invalid
  or workbook already contains a sheet with this name</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#createSafeSheetName(java.lang.String)"><code>WorkbookUtil.createSafeSheetName(String nameProposal)</code></a></dd></dl>
</li>
</ul>
<a name="createDialogsheet(java.lang.String, org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDialogsheet)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDialogsheet</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFDialogsheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFDialogsheet</a>&nbsp;createDialogsheet(java.lang.String&nbsp;sheetname,
                                org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDialogsheet&nbsp;dialogsheet)</pre>
</li>
</ul>
<a name="findFont(short, short, short, java.lang.String, boolean, boolean, short, byte)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findFont</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html" title="class in org.apache.poi.xssf.usermodel">XSSFFont</a>&nbsp;findFont(short&nbsp;boldWeight,
                short&nbsp;color,
                short&nbsp;fontHeight,
                java.lang.String&nbsp;name,
                boolean&nbsp;italic,
                boolean&nbsp;strikeout,
                short&nbsp;typeOffset,
                byte&nbsp;underline)</pre>
<div class="block">Finds a font that matches the one with the supplied attributes</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#findFont(short, short, short, java.lang.String, boolean, boolean, short, byte)">findFont</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the font with the matched attributes or <code>null</code></dd></dl>
</li>
</ul>
<a name="getActiveSheetIndex()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getActiveSheetIndex()</pre>
<div class="block">Convenience method to get the active sheet.  The active sheet is is the sheet
 which is currently displayed when the workbook is viewed in Excel.
 'Selected' sheet(s) is a distinct concept.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getActiveSheetIndex()">getActiveSheetIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the active sheet (0-based)</dd></dl>
</li>
</ul>
<a name="getAllPictures()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllPictures</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPictureData.html" title="class in org.apache.poi.xssf.usermodel">XSSFPictureData</a>&gt;&nbsp;getAllPictures()</pre>
<div class="block">Gets all pictures from the Workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getAllPictures()">getAllPictures</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the list of pictures (a list of <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPictureData.html" title="class in org.apache.poi.xssf.usermodel"><code>XSSFPictureData</code></a> objects.)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#addPicture(byte[], int)"><code>addPicture(byte[], int)</code></a></dd></dl>
</li>
</ul>
<a name="getCellStyleAt(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCellStyleAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCellStyle.html" title="class in org.apache.poi.xssf.usermodel">XSSFCellStyle</a>&nbsp;getCellStyleAt(short&nbsp;idx)</pre>
<div class="block">Get the cell style object at the given index</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getCellStyleAt(short)">getCellStyleAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>idx</code> - index within the set of styles</dd>
<dt><span class="strong">Returns:</span></dt><dd>XSSFCellStyle object at the index</dd></dl>
</li>
</ul>
<a name="getFontAt(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFontAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html" title="class in org.apache.poi.xssf.usermodel">XSSFFont</a>&nbsp;getFontAt(short&nbsp;idx)</pre>
<div class="block">Get the font at the given index number</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getFontAt(short)">getFontAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>idx</code> - index number</dd>
<dt><span class="strong">Returns:</span></dt><dd>XSSFFont at the index</dd></dl>
</li>
</ul>
<a name="getName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a>&nbsp;getName(java.lang.String&nbsp;name)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getName(java.lang.String)">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the defined name</dd>
<dt><span class="strong">Returns:</span></dt><dd>the defined name with the specified name. <code>null</code> if not found.</dd></dl>
</li>
</ul>
<a name="getNameAt(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFName.html" title="class in org.apache.poi.xssf.usermodel">XSSFName</a>&nbsp;getNameAt(int&nbsp;nameIndex)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNameAt(int)">getNameAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>nameIndex</code> - position of the named range (0-based)</dd>
<dt><span class="strong">Returns:</span></dt><dd>the defined name at the specified index</dd></dl>
</li>
</ul>
<a name="getNameIndex(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameIndex</h4>
<pre>public&nbsp;int&nbsp;getNameIndex(java.lang.String&nbsp;name)</pre>
<div class="block">Gets the named range index by his name
 <i>Note:</i>Excel named ranges are case-insensitive and
 this method performs a case-insensitive search.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNameIndex(java.lang.String)">getNameIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - named range name</dd>
<dt><span class="strong">Returns:</span></dt><dd>named range index</dd></dl>
</li>
</ul>
<a name="getNumCellStyles()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumCellStyles</h4>
<pre>public&nbsp;short&nbsp;getNumCellStyles()</pre>
<div class="block">Get the number of styles the workbook contains</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNumCellStyles()">getNumCellStyles</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>count of cell styles</dd></dl>
</li>
</ul>
<a name="getNumberOfFonts()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfFonts</h4>
<pre>public&nbsp;short&nbsp;getNumberOfFonts()</pre>
<div class="block">Get the number of fonts in the this workbook</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNumberOfFonts()">getNumberOfFonts</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>number of fonts</dd></dl>
</li>
</ul>
<a name="getNumberOfNames()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfNames</h4>
<pre>public&nbsp;int&nbsp;getNumberOfNames()</pre>
<div class="block">Get the number of named ranges in the this workbook</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNumberOfNames()">getNumberOfNames</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>number of named ranges</dd></dl>
</li>
</ul>
<a name="getNumberOfSheets()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfSheets</h4>
<pre>public&nbsp;int&nbsp;getNumberOfSheets()</pre>
<div class="block">Get the number of worksheets in the this workbook</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNumberOfSheets()">getNumberOfSheets</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>number of worksheets</dd></dl>
</li>
</ul>
<a name="getPrintArea(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrintArea</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPrintArea(int&nbsp;sheetIndex)</pre>
<div class="block">Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getPrintArea(int)">getPrintArea</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</dd>
<dt><span class="strong">Returns:</span></dt><dd>String Null if no print area has been defined</dd></dl>
</li>
</ul>
<a name="getSheet(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheet</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&nbsp;getSheet(java.lang.String&nbsp;name)</pre>
<div class="block">Get sheet with the given name (case insensitive match)</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheet(java.lang.String)">getSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the sheet</dd>
<dt><span class="strong">Returns:</span></dt><dd>XSSFSheet with the name provided or <code>null</code> if it does not exist</dd></dl>
</li>
</ul>
<a name="getSheetAt(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&nbsp;getSheetAt(int&nbsp;index)</pre>
<div class="block">Get the XSSFSheet object at the given index.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetAt(int)">getSheetAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - of the sheet number (0-based physical & logical)</dd>
<dt><span class="strong">Returns:</span></dt><dd>XSSFSheet at the provided index</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the index is out of range (index
            &lt; 0 || index &gt;= getNumberOfSheets()).</dd></dl>
</li>
</ul>
<a name="getSheetIndex(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getSheetIndex(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the index of the sheet by his name (case insensitive match)</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetIndex(java.lang.String)">getSheetIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the sheet name</dd>
<dt><span class="strong">Returns:</span></dt><dd>index of the sheet (0 based) or <tt>-1</tt if not found</dd></dl>
</li>
</ul>
<a name="getSheetIndex(org.apache.poi.ss.usermodel.Sheet)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getSheetIndex(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a>&nbsp;sheet)</pre>
<div class="block">Returns the index of the given sheet</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetIndex(org.apache.poi.ss.usermodel.Sheet)">getSheetIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheet</code> - the sheet to look up</dd>
<dt><span class="strong">Returns:</span></dt><dd>index of the sheet (0 based). <tt>-1</tt> if not found</dd></dl>
</li>
</ul>
<a name="getSheetName(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getSheetName(int&nbsp;sheetIx)</pre>
<div class="block">Get the sheet name</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetName(int)">getSheetName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - Number</dd>
<dt><span class="strong">Returns:</span></dt><dd>Sheet name</dd></dl>
</li>
</ul>
<a name="iterator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;java.util.Iterator&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&gt;&nbsp;iterator()</pre>
<div class="block">Allows foreach loops:
 <pre><code>
 XSSFWorkbook wb = new XSSFWorkbook(package);
 for(XSSFSheet sheet : wb){

 }
 </code></pre></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>iterator</code>&nbsp;in interface&nbsp;<code>java.lang.Iterable&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html" title="class in org.apache.poi.xssf.usermodel">XSSFSheet</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="isMacroEnabled()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMacroEnabled</h4>
<pre>public&nbsp;boolean&nbsp;isMacroEnabled()</pre>
<div class="block">Are we a normal workbook (.xlsx), or a
  macro enabled workbook (.xlsm)?</div>
</li>
</ul>
<a name="removeName(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeName</h4>
<pre>public&nbsp;void&nbsp;removeName(int&nbsp;nameIndex)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(int)">Workbook</a></code></strong></div>
<div class="block">Remove the defined name at the specified index</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(int)">removeName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>nameIndex</code> - named range index (0 based)</dd></dl>
</li>
</ul>
<a name="removeName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeName</h4>
<pre>public&nbsp;void&nbsp;removeName(java.lang.String&nbsp;name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(java.lang.String)">Workbook</a></code></strong></div>
<div class="block">Remove a defined name by name</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(java.lang.String)">removeName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the defined name</dd></dl>
</li>
</ul>
<a name="removePrintArea(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removePrintArea</h4>
<pre>public&nbsp;void&nbsp;removePrintArea(int&nbsp;sheetIndex)</pre>
<div class="block">Delete the printarea for the sheet specified</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removePrintArea(int)">removePrintArea</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - 0-based sheet index (0 = First Sheet)</dd></dl>
</li>
</ul>
<a name="removeSheetAt(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSheetAt</h4>
<pre>public&nbsp;void&nbsp;removeSheetAt(int&nbsp;index)</pre>
<div class="block">Removes sheet at the given index.<p/>

 Care must be taken if the removed sheet is the currently active or only selected sheet in
 the workbook. There are a few situations when Excel must have a selection and/or active
 sheet. (For example when printing - see Bug 40414).<br/>

 This method makes sure that if the removed sheet was active, another sheet will become
 active in its place.  Furthermore, if the removed sheet was the only selected sheet, another
 sheet will become selected.  The newly active/selected sheet will have the same index, or
 one less if the removed sheet was the last in the workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeSheetAt(int)">removeSheetAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - of the sheet  (0-based)</dd></dl>
</li>
</ul>
<a name="getMissingCellPolicy()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMissingCellPolicy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a>&nbsp;getMissingCellPolicy()</pre>
<div class="block">Retrieves the current policy on what to do when
  getting missing or blank cells from a row.
 The default is to return blank and null cells.
  <a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel"><code>Row.MissingCellPolicy</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getMissingCellPolicy()">getMissingCellPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
</dl>
</li>
</ul>
<a name="setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMissingCellPolicy</h4>
<pre>public&nbsp;void&nbsp;setMissingCellPolicy(<a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a>&nbsp;missingCellPolicy)</pre>
<div class="block">Sets the policy on what to do when
  getting missing or blank cells from a row.
 This will then apply to all calls to
  <a href="../../../../../org/apache/poi/ss/usermodel/Row.html#getCell(int)"><code>Row.getCell(int)</code></a>}. See
  <a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel"><code>Row.MissingCellPolicy</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy)">setMissingCellPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
</dl>
</li>
</ul>
<a name="setActiveSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setActiveSheet</h4>
<pre>public&nbsp;void&nbsp;setActiveSheet(int&nbsp;index)</pre>
<div class="block">Convenience method to set the active sheet.  The active sheet is is the sheet
 which is currently displayed when the workbook is viewed in Excel.
 'Selected' sheet(s) is a distinct concept.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setActiveSheet(int)">setActiveSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index of the active sheet (0-based)</dd></dl>
</li>
</ul>
<a name="getFirstVisibleTab()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstVisibleTab</h4>
<pre>public&nbsp;int&nbsp;getFirstVisibleTab()</pre>
<div class="block">Gets the first tab that is displayed in the list of tabs in excel.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getFirstVisibleTab()">getFirstVisibleTab</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>integer that contains the index to the active sheet in this book view.</dd></dl>
</li>
</ul>
<a name="setFirstVisibleTab(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFirstVisibleTab</h4>
<pre>public&nbsp;void&nbsp;setFirstVisibleTab(int&nbsp;index)</pre>
<div class="block">Sets the first tab that is displayed in the list of tabs in excel.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setFirstVisibleTab(int)">setFirstVisibleTab</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - integer that contains the index to the active sheet in this book view.</dd></dl>
</li>
</ul>
<a name="setPrintArea(int, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPrintArea</h4>
<pre>public&nbsp;void&nbsp;setPrintArea(int&nbsp;sheetIndex,
                java.lang.String&nbsp;reference)</pre>
<div class="block">Sets the printarea for the sheet provided
 <p>
 i.e. Reference = $A$1:$B$2</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setPrintArea(int, java.lang.String)">setPrintArea</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</dd><dd><code>reference</code> - Valid name Reference for the Print Area</dd></dl>
</li>
</ul>
<a name="setPrintArea(int, int, int, int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPrintArea</h4>
<pre>public&nbsp;void&nbsp;setPrintArea(int&nbsp;sheetIndex,
                int&nbsp;startColumn,
                int&nbsp;endColumn,
                int&nbsp;startRow,
                int&nbsp;endRow)</pre>
<div class="block">For the Convenience of Java Programmers maintaining pointers.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setPrintArea(int, int, int, int, int)">setPrintArea</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - Zero-based sheet index (0 = First Sheet)</dd><dd><code>startColumn</code> - Column to begin printarea</dd><dd><code>endColumn</code> - Column to end the printarea</dd><dd><code>startRow</code> - Row to begin the printarea</dd><dd><code>endRow</code> - Row to end the printarea</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setPrintArea(int, java.lang.String)"><code>setPrintArea(int, String)</code></a></dd></dl>
</li>
</ul>
<a name="setRepeatingRowsAndColumns(int, int, int, int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRepeatingRowsAndColumns</h4>
<pre>@Deprecated
public&nbsp;void&nbsp;setRepeatingRowsAndColumns(int&nbsp;sheetIndex,
                                         int&nbsp;startColumn,
                                         int&nbsp;endColumn,
                                         int&nbsp;startRow,
                                         int&nbsp;endRow)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#setRepeatingRows(org.apache.poi.ss.util.CellRangeAddress)"><code>XSSFSheet.setRepeatingRows(CellRangeAddress)</code></a>
        or <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFSheet.html#setRepeatingColumns(org.apache.poi.ss.util.CellRangeAddress)"><code>XSSFSheet.setRepeatingColumns(CellRangeAddress)</code></a></i></div>
<div class="block">Sets the repeating rows and columns for a sheet.
 <p/>
 To set just repeating columns:
 <pre>
  workbook.setRepeatingRowsAndColumns(0,0,1,-1,-1);
 </pre>
 To set just repeating rows:
 <pre>
  workbook.setRepeatingRowsAndColumns(0,-1,-1,0,4);
 </pre>
 To remove all repeating rows and columns for a sheet.
 <pre>
  workbook.setRepeatingRowsAndColumns(0,-1,-1,-1,-1);
 </pre></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setRepeatingRowsAndColumns(int, int, int, int, int)">setRepeatingRowsAndColumns</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - 0 based index to sheet.</dd><dd><code>startColumn</code> - 0 based start of repeating columns.</dd><dd><code>endColumn</code> - 0 based end of repeating columns.</dd><dd><code>startRow</code> - 0 based start of repeating rows.</dd><dd><code>endRow</code> - 0 based end of repeating rows.</dd></dl>
</li>
</ul>
<a name="setSelectedTab(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelectedTab</h4>
<pre>public&nbsp;void&nbsp;setSelectedTab(int&nbsp;index)</pre>
<div class="block">We only set one sheet as selected for compatibility with HSSF.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSelectedTab(int)">setSelectedTab</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index of the sheet to select (0 based)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html#setSelected(boolean)"><code>Sheet.setSelected(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="setSheetName(int, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetName</h4>
<pre>public&nbsp;void&nbsp;setSheetName(int&nbsp;sheetIndex,
                java.lang.String&nbsp;sheetname)</pre>
<div class="block">Set the sheet name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetName(int, java.lang.String)">setSheetName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - sheet number (0 based)</dd><dd><code>sheetname</code> - the new sheet name</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the name is null or invalid
  or workbook already contains a sheet with this name</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#createSheet(java.lang.String)"><code>createSheet(String)</code></a>, 
<a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#createSafeSheetName(java.lang.String)"><code>WorkbookUtil.createSafeSheetName(String nameProposal)</code></a></dd></dl>
</li>
</ul>
<a name="setSheetOrder(java.lang.String, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetOrder</h4>
<pre>public&nbsp;void&nbsp;setSheetOrder(java.lang.String&nbsp;sheetname,
                 int&nbsp;pos)</pre>
<div class="block">sets the order of appearance for a given sheet.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetOrder(java.lang.String, int)">setSheetOrder</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetname</code> - the name of the sheet to reorder</dd><dd><code>pos</code> - the position that we want to insert the sheet into (0 based)</dd></dl>
</li>
</ul>
<a name="commit()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre>protected&nbsp;void&nbsp;commit()
               throws java.io.IOException</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#commit()">POIXMLDocumentPart</a></code></strong></div>
<div class="block">Save the content in the underlying package part.
 Default implementation is empty meaning that the package part is left unmodified.

 Sub-classes should override and add logic to marshal the "model" into Ooxml4J.

 For example, the code saving a generic XML entry may look as follows:
 <pre><code>
 protected void commit() throws IOException {
   PackagePart part = getPackagePart();
   OutputStream out = part.getOutputStream();
   XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
   bean.save(out, DEFAULT_XML_OPTIONS);
   out.close();
 }
  </code></pre></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html#commit()">commit</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="close()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
           throws java.io.IOException</pre>
<div class="block">Closes the underlying <a href="../../../../../org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc"><code>OPCPackage</code></a> from which
  the Workbook was read, if any. Has no effect on newly 
  created Workbooks.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/POIXMLDocument.html#close()">close</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getSharedStringSource()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSharedStringSource</h4>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public&nbsp;<a href="../../../../../org/apache/poi/xssf/model/SharedStringsTable.html" title="class in org.apache.poi.xssf.model">SharedStringsTable</a>&nbsp;getSharedStringSource()</pre>
<div class="block">Returns SharedStringsTable - tha cache of string for this workbook</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the shared string table</dd></dl>
</li>
</ul>
<a name="getStylesSource()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStylesSource</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/model/StylesTable.html" title="class in org.apache.poi.xssf.model">StylesTable</a>&nbsp;getStylesSource()</pre>
<div class="block">Return a object representing a collection of shared objects used for styling content,
 e.g. fonts, cell styles, colors, etc.</div>
</li>
</ul>
<a name="getTheme()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTheme</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/model/ThemesTable.html" title="class in org.apache.poi.xssf.model">ThemesTable</a>&nbsp;getTheme()</pre>
<div class="block">Returns the Theme of current workbook.</div>
</li>
</ul>
<a name="getCreationHelper()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreationHelper</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCreationHelper.html" title="class in org.apache.poi.xssf.usermodel">XSSFCreationHelper</a>&nbsp;getCreationHelper()</pre>
<div class="block">Returns an object that handles instantiating concrete
  classes of the various instances for XSSF.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getCreationHelper()">getCreationHelper</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
</dl>
</li>
</ul>
<a name="isDate1904()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDate1904</h4>
<pre>protected&nbsp;boolean&nbsp;isDate1904()</pre>
<div class="block">Gets a boolean value that indicates whether the date systems used in the workbook starts in 1904.
 <p>
 The default value is false, meaning that the workbook uses the 1900 date system,
 where 1/1/1900 is the first day in the system..
 </p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the date systems used in the workbook starts in 1904</dd></dl>
</li>
</ul>
<a name="getAllEmbedds()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllEmbedds</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/openxml4j/opc/PackagePart.html" title="class in org.apache.poi.openxml4j.opc">PackagePart</a>&gt;&nbsp;getAllEmbedds()
                                          throws <a href="../../../../../org/apache/poi/openxml4j/exceptions/OpenXML4JException.html" title="class in org.apache.poi.openxml4j.exceptions">OpenXML4JException</a></pre>
<div class="block">Get the document's embedded files.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/POIXMLDocument.html#getAllEmbedds()">getAllEmbedds</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/poi/openxml4j/exceptions/OpenXML4JException.html" title="class in org.apache.poi.openxml4j.exceptions">OpenXML4JException</a></code></dd></dl>
</li>
</ul>
<a name="isHidden()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHidden</h4>
<pre>public&nbsp;boolean&nbsp;isHidden()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isHidden()">isHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>false</code> if this workbook is not visible in the GUI</dd></dl>
</li>
</ul>
<a name="setHidden(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHidden</h4>
<pre>public&nbsp;void&nbsp;setHidden(boolean&nbsp;hiddenFlag)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setHidden(boolean)">setHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>hiddenFlag</code> - pass <code>false</code> to make the workbook visible in the GUI</dd></dl>
</li>
</ul>
<a name="isSheetHidden(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSheetHidden</h4>
<pre>public&nbsp;boolean&nbsp;isSheetHidden(int&nbsp;sheetIx)</pre>
<div class="block">Check whether a sheet is hidden.
 <p>
 Note that a sheet could instead be set to be very hidden, which is different
  (<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isSheetVeryHidden(int)"><code>isSheetVeryHidden(int)</code></a>)
 </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetHidden(int)">isSheetHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - Number</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if sheet is hidden</dd></dl>
</li>
</ul>
<a name="isSheetVeryHidden(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSheetVeryHidden</h4>
<pre>public&nbsp;boolean&nbsp;isSheetVeryHidden(int&nbsp;sheetIx)</pre>
<div class="block">Check whether a sheet is very hidden.
 <p>
 This is different from the normal hidden status
  (<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#isSheetHidden(int)"><code>isSheetHidden(int)</code></a>)
 </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetVeryHidden(int)">isSheetVeryHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - sheet index to check</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if sheet is very hidden</dd></dl>
</li>
</ul>
<a name="setSheetHidden(int, boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetHidden</h4>
<pre>public&nbsp;void&nbsp;setSheetHidden(int&nbsp;sheetIx,
                  boolean&nbsp;hidden)</pre>
<div class="block">Sets the visible state of this sheet.
 <p>
   Calling <code>setSheetHidden(sheetIndex, true)</code> is equivalent to
   <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN)</code>.
 <br/>
   Calling <code>setSheetHidden(sheetIndex, false)</code> is equivalent to
   <code>setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE)</code>.
 </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetHidden(int, boolean)">setSheetHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - the 0-based index of the sheet</dd><dd><code>hidden</code> - whether this sheet is hidden</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFWorkbook.html#setSheetHidden(int, int)"><code>setSheetHidden(int, int)</code></a></dd></dl>
</li>
</ul>
<a name="setSheetHidden(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetHidden</h4>
<pre>public&nbsp;void&nbsp;setSheetHidden(int&nbsp;sheetIx,
                  int&nbsp;state)</pre>
<div class="block">Hide or unhide a sheet.

 <ul>
  <li>0 - visible. </li>
  <li>1 - hidden. </li>
  <li>2 - very hidden.</li>
 </ul></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetHidden(int, int)">setSheetHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - the sheet index (0-based)</dd><dd><code>state</code> - one of the following <code>Workbook</code> constants:
        <code>Workbook.SHEET_STATE_VISIBLE</code>,
        <code>Workbook.SHEET_STATE_HIDDEN</code>, or
        <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the supplied sheet index or state is invalid</dd></dl>
</li>
</ul>
<a name="onDeleteFormula(org.apache.poi.xssf.usermodel.XSSFCell)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDeleteFormula</h4>
<pre>protected&nbsp;void&nbsp;onDeleteFormula(<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCell.html" title="class in org.apache.poi.xssf.usermodel">XSSFCell</a>&nbsp;cell)</pre>
<div class="block">Fired when a formula is deleted from this workbook,
 for example when calling cell.setCellFormula(null)</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFCell.html#setCellFormula(java.lang.String)"><code>XSSFCell.setCellFormula(String)</code></a></dd></dl>
</li>
</ul>
<a name="getCalculationChain()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCalculationChain</h4>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public&nbsp;<a href="../../../../../org/apache/poi/xssf/model/CalculationChain.html" title="class in org.apache.poi.xssf.model">CalculationChain</a>&nbsp;getCalculationChain()</pre>
<div class="block">Return the <a href="../../../../../org/apache/poi/xssf/model/CalculationChain.html" title="class in org.apache.poi.xssf.model"><code>CalculationChain</code></a> object for this workbook
 <p>
   The calculation chain object specifies the order in which the cells in a workbook were last calculated
 </p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>CalculationChain</code> object or <code>null</code> if not defined</dd></dl>
</li>
</ul>
<a name="getExternalLinksTable()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalLinksTable</h4>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xssf/model/ExternalLinksTable.html" title="class in org.apache.poi.xssf.model">ExternalLinksTable</a>&gt;&nbsp;getExternalLinksTable()</pre>
<div class="block">Returns the list of <a href="../../../../../org/apache/poi/xssf/model/ExternalLinksTable.html" title="class in org.apache.poi.xssf.model"><code>ExternalLinksTable</code></a> object for this workbook
 
 <p>The external links table specifies details of named ranges etc
  that are referenced from other workbooks, along with the last seen
  values of what they point to.</p>

 <p>Note that Excel uses index 0 for the current workbook, so the first
  External Links in a formula would be '[1]Foo' which corresponds to
  entry 0 in this list.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>ExternalLinksTable</code> list, which may be empty</dd></dl>
</li>
</ul>
<a name="getCustomXMLMappings()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCustomXMLMappings</h4>
<pre>public&nbsp;java.util.Collection&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFMap.html" title="class in org.apache.poi.xssf.usermodel">XSSFMap</a>&gt;&nbsp;getCustomXMLMappings()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>a collection of custom XML mappings defined in this workbook</dd></dl>
</li>
</ul>
<a name="getMapInfo()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMapInfo</h4>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public&nbsp;<a href="../../../../../org/apache/poi/xssf/model/MapInfo.html" title="class in org.apache.poi.xssf.model">MapInfo</a>&nbsp;getMapInfo()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the helper class used to query the custom XML mapping defined in this workbook</dd></dl>
</li>
</ul>
<a name="linkExternalWorkbook(java.lang.String, org.apache.poi.ss.usermodel.Workbook)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>linkExternalWorkbook</h4>
<pre>public&nbsp;int&nbsp;linkExternalWorkbook(java.lang.String&nbsp;name,
                       <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>&nbsp;workbook)</pre>
<div class="block">Adds the External Link Table part and relations required to allow formulas 
  referencing the specified external workbook to be added to this one. Allows
  formulas such as "[MyOtherWorkbook.xlsx]Sheet3!$A$5" to be added to the 
  file, for workbooks not already linked / referenced.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#linkExternalWorkbook(java.lang.String, org.apache.poi.ss.usermodel.Workbook)">linkExternalWorkbook</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name the workbook will be referenced as in formulas</dd><dd><code>workbook</code> - The open workbook to fetch the link required information from</dd></dl>
</li>
</ul>
<a name="isStructureLocked()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStructureLocked</h4>
<pre>public&nbsp;boolean&nbsp;isStructureLocked()</pre>
<div class="block">Specifies a boolean value that indicates whether structure of workbook is locked. <br/>
 A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be moved,
 deleted, hidden, unhidden, or renamed, and new worksheets can't be inserted.<br/>
 A value of false indicates the structure of the workbook is not locked.<br/></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if structure of workbook is locked</dd></dl>
</li>
</ul>
<a name="isWindowsLocked()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWindowsLocked</h4>
<pre>public&nbsp;boolean&nbsp;isWindowsLocked()</pre>
<div class="block">Specifies a boolean value that indicates whether the windows that comprise the workbook are locked. <br/>
 A value of true indicates the workbook windows are locked. Windows are the same size and position each time the
 workbook is opened.<br/>
 A value of false indicates the workbook windows are not locked.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if windows that comprise the workbook are locked</dd></dl>
</li>
</ul>
<a name="isRevisionLocked()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRevisionLocked</h4>
<pre>public&nbsp;boolean&nbsp;isRevisionLocked()</pre>
<div class="block">Specifies a boolean value that indicates whether the workbook is locked for revisions.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the workbook is locked for revisions.</dd></dl>
</li>
</ul>
<a name="lockStructure()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lockStructure</h4>
<pre>public&nbsp;void&nbsp;lockStructure()</pre>
<div class="block">Locks the structure of workbook.</div>
</li>
</ul>
<a name="unLockStructure()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unLockStructure</h4>
<pre>public&nbsp;void&nbsp;unLockStructure()</pre>
<div class="block">Unlocks the structure of workbook.</div>
</li>
</ul>
<a name="lockWindows()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lockWindows</h4>
<pre>public&nbsp;void&nbsp;lockWindows()</pre>
<div class="block">Locks the windows that comprise the workbook.</div>
</li>
</ul>
<a name="unLockWindows()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unLockWindows</h4>
<pre>public&nbsp;void&nbsp;unLockWindows()</pre>
<div class="block">Unlocks the windows that comprise the workbook.</div>
</li>
</ul>
<a name="lockRevision()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lockRevision</h4>
<pre>public&nbsp;void&nbsp;lockRevision()</pre>
<div class="block">Locks the workbook for revisions.</div>
</li>
</ul>
<a name="unLockRevision()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unLockRevision</h4>
<pre>public&nbsp;void&nbsp;unLockRevision()</pre>
<div class="block">Unlocks the workbook for revisions.</div>
</li>
</ul>
<a name="setWorkbookPassword(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWorkbookPassword</h4>
<pre>public&nbsp;void&nbsp;setWorkbookPassword(java.lang.String&nbsp;password,
                       <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</pre>
<div class="block">Sets the workbook password.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - if null, the password will be removed</dd><dd><code>hashAlgo</code> - if null, the password will be set as XOR password (Excel 2010 and earlier)
  otherwise the given algorithm is used for calculating the hash password (Excel 2013)</dd></dl>
</li>
</ul>
<a name="validateWorkbookPassword(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateWorkbookPassword</h4>
<pre>public&nbsp;boolean&nbsp;validateWorkbookPassword(java.lang.String&nbsp;password)</pre>
<div class="block">Validate the password against the stored hash, the hashing method will be determined
  by the existing password attributes</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true, if the hashes match (... though original password may differ ...)</dd></dl>
</li>
</ul>
<a name="setRevisionsPassword(java.lang.String, org.apache.poi.poifs.crypt.HashAlgorithm)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRevisionsPassword</h4>
<pre>public&nbsp;void&nbsp;setRevisionsPassword(java.lang.String&nbsp;password,
                        <a href="../../../../../org/apache/poi/poifs/crypt/HashAlgorithm.html" title="enum in org.apache.poi.poifs.crypt">HashAlgorithm</a>&nbsp;hashAlgo)</pre>
<div class="block">Sets the revisions password.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - if null, the password will be removed</dd><dd><code>hashAlgo</code> - if null, the password will be set as XOR password (Excel 2010 and earlier)
  otherwise the given algorithm is used for calculating the hash password (Excel 2013)</dd></dl>
</li>
</ul>
<a name="validateRevisionsPassword(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateRevisionsPassword</h4>
<pre>public&nbsp;boolean&nbsp;validateRevisionsPassword(java.lang.String&nbsp;password)</pre>
<div class="block">Validate the password against the stored hash, the hashing method will be determined
  by the existing password attributes</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the hashes match (... though original password may differ ...)</dd></dl>
</li>
</ul>
<a name="unLock()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unLock</h4>
<pre>public&nbsp;void&nbsp;unLock()</pre>
<div class="block">Removes the workbook protection settings</div>
</li>
</ul>
<a name="addToolPack(org.apache.poi.ss.formula.udf.UDFFinder)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToolPack</h4>
<pre>public&nbsp;void&nbsp;addToolPack(<a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a>&nbsp;toopack)</pre>
<div class="block">Register a new toolpack in this workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#addToolPack(org.apache.poi.ss.formula.udf.UDFFinder)">addToolPack</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>toopack</code> - the toolpack to register</dd></dl>
</li>
</ul>
<a name="setForceFormulaRecalculation(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForceFormulaRecalculation</h4>
<pre>public&nbsp;void&nbsp;setForceFormulaRecalculation(boolean&nbsp;value)</pre>
<div class="block">Whether the application shall perform a full recalculation when the workbook is opened.
 <p>
 Typically you want to force formula recalculation when you modify cell formulas or values
 of a workbook previously created by Excel. When set to true, this flag will tell Excel
 that it needs to recalculate all formulas in the workbook the next time the file is opened.
 </p>
 <p>
 Note, that recalculation updates cached formula results and, thus, modifies the workbook.
 Depending on the version, Excel may prompt you with "Do you want to save the changes in <em>filename</em>?"
 on close.
 </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setForceFormulaRecalculation(boolean)">setForceFormulaRecalculation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - true if the application will perform a full recalculation of
 workbook values when the workbook is opened</dd><dt><span class="strong">Since:</span></dt>
  <dd>3.8</dd></dl>
</li>
</ul>
<a name="getForceFormulaRecalculation()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForceFormulaRecalculation</h4>
<pre>public&nbsp;boolean&nbsp;getForceFormulaRecalculation()</pre>
<div class="block">Whether Excel will be asked to recalculate all formulas when the  workbook is opened.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getForceFormulaRecalculation()">getForceFormulaRecalculation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Since:</span></dt>
  <dd>3.8</dd></dl>
</li>
</ul>
<a name="addPivotCache(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPivotCache</h4>
<pre><a href="../../../../../org/apache/poi/util/Beta.html" title="annotation in org.apache.poi.util">@Beta</a>
protected&nbsp;org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotCache&nbsp;addPivotCache(java.lang.String&nbsp;rId)</pre>
<div class="block">Add pivotCache to the workbook</div>
</li>
</ul>
<a name="getPivotTables()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPivotTables</h4>
<pre><a href="../../../../../org/apache/poi/util/Beta.html" title="annotation in org.apache.poi.util">@Beta</a>
public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPivotTable.html" title="class in org.apache.poi.xssf.usermodel">XSSFPivotTable</a>&gt;&nbsp;getPivotTables()</pre>
</li>
</ul>
<a name="setPivotTables(java.util.List)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setPivotTables</h4>
<pre><a href="../../../../../org/apache/poi/util/Beta.html" title="annotation in org.apache.poi.util">@Beta</a>
protected&nbsp;void&nbsp;setPivotTables(java.util.List&lt;<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFPivotTable.html" title="class in org.apache.poi.xssf.usermodel">XSSFPivotTable</a>&gt;&nbsp;pivotTables)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XSSFWorkbook.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFVMLDrawing.html" title="class in org.apache.poi.xssf.usermodel"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/xssf/usermodel/XSSFWorkbook.html" target="_top">FRAMES</a></li>
<li><a href="XSSFWorkbook.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
